/*---------------------------------------------------------------------------/
/  FatFs - FAT file system module include file  R0.09b    (C)ChaN, 2013
/----------------------------------------------------------------------------/
/ FatFs module is a generic FAT file system module for small embedded systems.
/ This is a free software that opened for education, research and commercial
/ developments under license policy of following terms.
/
/  Copyright (C) 2013, ChaN, all right reserved.
/
/ * The FatFs module is a free software and there is NO WARRANTY.
/ * No restriction on use. You can use, modify and redistribute it for
/   personal, non-profit or commercial product UNDER YOUR RESPONSIBILITY.
/ * Redistributions of source code must retain the above copyright notice.
/
/----------------------------------------------------------------------------*/

#ifndef _FATFS
#define _FATFS	82786	/* Revision ID */

#ifdef __cplusplus
extern "C" {
#endif

#include "integer.h"		/* Basic integer types */
#include "config_fatfs.h"		/* FatFs configuration options */

#if _FS_REENTRANT
#include "FreeRTOS.h"
#include "semphr.h"
#endif

#if _FATFS != _FFCONF
#error Wrong configuration file (ffconf.h).
#endif



/* Definitions of volume management */

#if _MULTI_PARTITION		/* Multiple partition configuration */
typedef struct {
	BYTE pd;	/* Physical drive number */
	BYTE pt;	/* Partition: 0:Auto detect, 1-4:Forced partition) */
} PARTITION;
extern PARTITION VolToPart[];	/* Volume - Partition resolution table */
#define LD2PD(vol) (VolToPart[vol].pd)	/* Get physical drive number */
#define LD2PT(vol) (VolToPart[vol].pt)	/* Get partition index */

#else							/* Single partition configuration */
#define LD2PD(vol) (BYTE)(vol)	/* Each logical drive is bound to the same physical drive number */
#define LD2PT(vol) 0			/* Always mounts the 1st partition or in SFD */

#endif



/* Type of path name strings on FatFs API */

#if _LFN_UNICODE			/* Unicode string */
#if !_USE_LFN
#error _LFN_UNICODE must be 0 in non-LFN cfg.
#endif
#ifndef _INC_TCHAR
typedef WCHAR TCHAR;
#define _T(x) L ## x
#define _TEXT(x) L ## x
#endif

#else						/* ANSI/OEM string */
#ifndef _INC_TCHAR
typedef char TCHAR;
#define _T(x) x
#define _TEXT(x) x
#endif

#endif



/* File system object structure (FATFS) */

typedef struct {
	BYTE	fs_type;		/* FAT sub-type (0:Not mounted) */
	BYTE	drv;			/* Physical drive number */
	BYTE	csize;			/* Sectors per cluster (1,2,4...128) */
	BYTE	n_fats;			/* Number of FAT copies (1,2) */
	BYTE	wflag;			/* win[] dirty flag (1:must be written back) */
	BYTE	fsi_flag;		/* fsinfo dirty flag (1:must be written back) */
	WORD	id;				/* File system mount ID */
	WORD	n_rootdir;		/* Number of root directory entries (FAT12/16) */
#if _MAX_SS != 512
	WORD	ssize;			/* Bytes per sector (512, 1024, 2048 or 4096) */
#endif
#if _FS_REENTRANT
	_SYNC_t	sobj;			/* Identifier of sync object */
#endif
#if !_FS_READONLY
	DWORD	last_clust;		/* Last allocated cluster */
	DWORD	free_clust;		/* Number of free clusters */
	DWORD	fsi_sector;		/* fsinfo sector (FAT32) */
#endif
#if _FS_RPATH
	DWORD	cdir;			/* Current directory start cluster (0:root) */
#endif
	DWORD	n_fatent;		/* Number of FAT entries (= number of clusters + 2) */
	DWORD	fsize;			/* Sectors per FAT */
	DWORD	volbase;		/* Volume start sector */
	DWORD	fatbase;		/* FAT start sector */
	DWORD	dirbase;		/* Root directory start sector (FAT32:Cluster#) */
	DWORD	database;		/* Data start sector */
	DWORD	winsect;		/* Current sector appearing in the win[] */
	BYTE	win[_MAX_SS];	/* Disk access window for Directory, FAT (and Data on tiny cfg) */
} FATFS;



/* File object structure (FIL) */

typedef struct {
	FATFS*	fs;				/* Pointer to the related file system object (**do not change order**) */
	WORD	id;				/* Owner file system mount ID (**do not change order**) */
	BYTE	flag;			/* File status flags */
	BYTE	pad1;
	DWORD	fptr;			/* File read/write pointer (0ed on file open) */
	DWORD	fsize;			/* File size */
	DWORD	sclust;			/* File data start cluster (0:no data cluster, always 0 when fsize is 0) */
	DWORD	clust;			/* Current cluster of fpter */
	DWORD	dsect;			/* Current data sector of fpter */
#if !_FS_READONLY
	DWORD	dir_sect;		/* Sector containing the directory entry */
	BYTE*	dir_ptr;		/* Pointer to the directory entry in the window */
#endif
#if _USE_FASTSEEK
	DWORD*	cltbl;			/* Pointer to the cluster link map table (null on file open) */
#endif
#if _FS_LOCK
	UINT	lockid;			/* File lock ID (index of file semaphore table Files[]) */
#endif
#if !_FS_TINY
	BYTE	buf[_MAX_SS];	/* File data read/write buffer */
#endif
} FIL;



/* Directory object structure (DIR) */

typedef struct {
	FATFS*	fs;				/* Pointer to the owner file system object (**do not change order**) */
	WORD	id;				/* Owner file system mount ID (**do not change order**) */
	WORD	index;			/* Current read/write index number */
	DWORD	sclust;			/* Table start cluster (0:Root dir) */
	DWORD	clust;			/* Current cluster */
	DWORD	sect;			/* Current sector */
	BYTE*	dir;			/* Pointer to the current SFN entry in the win[] */
	BYTE*	fn;				/* Pointer to the SFN (in/out) {file[8],ext[3],status[1]} */
#if _USE_LFN
	WCHAR*	lfn;			/* Pointer to the LFN working buffer */
	WORD	lfn_idx;		/* Last matched LFN index number (0xFFFF:No LFN) */
#endif
} DIR;



/* File status structure (FILINFO) */

typedef struct {
	DWORD	fsize;			/* File size */
	WORD	fdate;			/* Last modified date */
	WORD	ftime;			/* Last modified time */
	BYTE	fattrib;		/* Attribute */
	TCHAR	fname[13];		/* Short file name (8.3 format) */
#if _USE_LFN
	TCHAR*	lfname;			/* Pointer to the LFN buffer */
	UINT 	lfsize;			/* Size of LFN buffer in TCHAR */
#endif
} FILINFO;



/* File function return code (FRESULT) */

typedef enum {
	FR_OK = 0,				/* (0) Succeeded */
	FR_DISK_ERR,			/* (1) A hard error occurred in the low level disk I/O layer */
	FR_INT_ERR,				/* (2) Assertion failed */
	FR_NOT_READY,			/* (3) The physical drive cannot work */
	FR_NO_FILE,				/* (4) Could not find the file */
	FR_NO_PATH,				/* (5) Could not find the path */
	FR_INVALID_NAME,		/* (6) The path name format is invalid */
	FR_DENIED,				/* (7) Access denied due to prohibited access or directory full */
	FR_EXIST,				/* (8) Access denied due to prohibited access */
	FR_INVALID_OBJECT,		/* (9) The file/directory object is invalid */
	FR_WRITE_PROTECTED,		/* (10) The physical drive is write protected */
	FR_INVALID_DRIVE,		/* (11) The logical drive number is invalid */
	FR_NOT_ENABLED,			/* (12) The volume has no work area */
	FR_NO_FILESYSTEM,		/* (13) There is no valid FAT volume */
	FR_MKFS_ABORTED,		/* (14) The f_mkfs() aborted due to any parameter error */
	FR_TIMEOUT,				/* (15) Could not get a grant to access the volume within defined period */
	FR_LOCKED,				/* (16) The operation is rejected according to the file sharing policy */
	FR_NOT_ENOUGH_CORE,		/* (17) LFN working buffer could not be allocated */
	FR_TOO_MANY_OPEN_FILES,	/* (18) Number of open files > _FS_SHARE */
	FR_INVALID_PARAMETER	/* (19) Given parameter is invalid */
} FRESULT;



/*--------------------------------------------------------------*/
/* FatFs module application interface                           */

/** \brief Mount/Unmount a Logical Drive.
 *
 * \param _vol	Logical drive number to be mounted/unmounted.
 * \param _fs	Pointer to new file system object (NULL for unmount).
 *
 * \return Status.
 *
 */
FRESULT f_mount (BYTE vol, FATFS* fs);								/* Mount/Unmount a logical drive */

/** \brief Open or Create a File.
 *
 * \param _fp	Pointer to the blank file object.
 * \param _path	Pointer to the file name.
 * \param _mode	Access mode and file open mode flags.
 *
 * \return File function return code (FRESULT)
 *
 */
FRESULT f_open (FIL *_fp, const TCHAR *_path, BYTE _mode);

/** \brief Read data from a file.
 *
 * \param _fp	Pointer to the file object.
 * \param _buff	Pointer to data buffer.
 * \param _btr	Number of bytes to read.
 * \param _br	Pointer to number of bytes read.
 *
 */
FRESULT f_read(FIL *_fp, void *_buff, UINT _btr, UINT *_br);

/** \brief Write data to a file.
 *
 * \param _fp	Pointer to the file object.
 * \param _buff	Pointer to the data to be written.
 * \param _btw	Number of bytes to write.
 * \param _bw	Pointer to number of bytes written.
 *
 * \return Status.
 *
 */
FRESULT f_write(FIL *_fp, const void *_buff, UINT _btw, UINT *_bw);

/**\brief Synchronize the File Object.
 *
 * \param _fp	Pointer to the file object.
 *
 */
FRESULT f_sync(FIL *_fp);											/* Flush cached data of a writing file */

/** \brief Close an open file object.
 *
 * \param _fp	Pointer to the file object to be closed.
 *
 */
FRESULT f_close(FIL *_fp);

/** \brief Change current drive.
 *
 * \param _drv		Drive number.
 *
 */
FRESULT f_chdrive(BYTE _drv);


/** \brief Change current directory.
 *
 * \param _path		Pointer to the directory path.
 *
 */
FRESULT f_chdir(const TCHAR* path);

/** \brief Get current directory.
 *
 * \param _buff		Pointer to the directory path.
 * \param _len		Size of path.
 *
 */
FRESULT f_getcwd(TCHAR *_buff, UINT _len);

/** \brief Seek File R/W Pointer.
 *
 * \param _fp	Pointer to the file object.
 * \param _ofs	File pointer from top of file.
 *
 */
FRESULT f_lseek (FIL *_fp, DWORD _ofs);

/** \brief Create a Directory Object.
 *
 * \param _dj		Pointer to directory object to create.
 * \param _path		Pointer to the directory path.
 *
 */
FRESULT f_opendir (DIR *_dj, const TCHAR *_path);

/** \brief Read Directory Entry in Sequence.
 *
 * \param _dj	Pointer to the open directory object.
 * \param _fno	Pointer to file information to return.
 *
 */
FRESULT f_readdir (DIR *_dj, FILINFO *_fno);

/** \brief Get File Status.
 *
 * \param _path		Pointer to the file path.
 * \param _fno		Pointer to file information to return.
 *
 */
FRESULT f_stat(const TCHAR *_path, FILINFO *_fno);

/** \brief Get Number of Free Clusters.
 *
 * \param _path		Path name of the logical drive number.
 * \param _nclst	Pointer to a variable to return number of free clusters.
 * \param _fatfs	Pointer to return pointer to corresponding file system object.
 *
 */
FRESULT f_getfree(const TCHAR *_path, DWORD *_nclst, FATFS **_fatfs);

/** \brief Truncate File.
 *
 * \param _fp	Pointer to the file object.
 *
 */
FRESULT f_truncate(FIL *_fp);

/** \brief Delete a File or Directory.
 *
 * \param _path		Pointer to the file or directory path.
 *
 */
FRESULT f_unlink(const TCHAR *_path);

/**\brief Create a Directory.
 *
 * \param _path		Pointer to the directory path.
 *
 */
FRESULT	f_mkdir(const TCHAR *_path);

/** Change Attribute.
 *
 * \param _path		Pointer to the file path.
 * \param _value	Attribute bits.
 * \param _mask		Attribute mask to change.
 *
 */
FRESULT f_chmod (const TCHAR *_path, BYTE _value, BYTE _mask);

/** \brief Change Time Stamp.
 *
 * \param _path	Pointer to the file/directory name.
 * \param _fno	Pointer to the time stamp to be set.
 *
 */
FRESULT f_utime (const TCHAR *_path, const FILINFO *_fno);

/** \brief Rename File/Directory.
 *
 * \param _path_old		Pointer to the old name.
 * \param _path_new		Pointer to the new name.
 *
 */
FRESULT f_rename(const TCHAR *_path_old, const TCHAR *_path_new);

/** \brief Get volume label.
 *
 * \param _path		Path name of the logical drive number.
 * \param _label	Pointer to a buffer to return the volume label.
 * \param _sn		Pointer to a variable to return the volume serial number.
 *
 */
FRESULT	f_getlabel (const TCHAR *_path, TCHAR *_label, DWORD *_sn);	/* Get volume label */

/** \brief Set volume label.
 *
 * \param _label	Pointer to the volume label to set.
 *
 */
FRESULT	f_setlabel(const TCHAR *_label);

/** \brief Forward data to the stream directly (available on only tiny cfg).
 *
 * \param _fp	Pointer to the file object.
 * \param func	Pointer to the streaming function.
 * \param _btf	Number of bytes to forward.
 * \param _bf	Pointer to number of bytes forwarded.
 *
 */
FRESULT f_forward (FIL *_fp, UINT(*func)(const BYTE*,UINT), UINT _btf, UINT *_bf);

/** \brief Create File System on the Drive.
 *
 * \param _vol	Logical drive number.
 * \param _sfd	Partitioning rule 0:FDISK, 1:SFD.
 * \param _au	Allocation unit size [bytes].
 *
 */
FRESULT f_mkfs(BYTE _vol, BYTE _sfd, UINT _au);

/** \brief Divide Physical Drive.
 *
 * \param _pdrv		Physical drive number.
 * \param _szt		Pointer to the size table for each partitions.
 * \param _work		Pointer to the working buffer.
 *
 */
FRESULT	f_fdisk (BYTE _pdrv, const DWORD _szt[], void *_work);

/** \brief Put a character to the file.
 *
 * \param	_c	A character to be output.
 * \param	_fp	Pointer to the file object.
 *
 */
int f_putc(TCHAR _c, FIL *_fp);

/** \brief Put a string to the file.
 *
 * \param _str	Pointer to the string to be output.
 * \param _fp	Pointer to the file object.
 *
 */
int f_puts(const TCHAR *_str, FIL *_cp);

/** \brief Put a formatted string to the file.
 *
 * \param _fp	Pointer to the file object.
 * \param _str	Pointer to the format string.
 * \...			Optional arguments...
 *
 */
int f_printf(FIL *_fp, const TCHAR *_str, ...);

/** \brief Get a string from the file.
 *
 * \param _buff	Pointer to the string buffer to read.
 * \param _len	Size of string buffer (characters).
 * \param _fp	Pointer to the file object.
 *
 */
TCHAR *f_gets (TCHAR *_buff, int _len, FIL *_fp);

#define f_eof(fp) (((fp)->fptr == (fp)->fsize) ? 1 : 0)
#define f_error(fp) (((fp)->flag & FA__ERROR) ? 1 : 0)
#define f_tell(fp) ((fp)->fptr)
#define f_size(fp) ((fp)->fsize)

#ifndef EOF
#define EOF (-1)
#endif




/*--------------------------------------------------------------*/
/* Additional user defined functions                            */

/* RTC function */
#if !_FS_READONLY
/**
 * \brief Current time returned is packed into a DWORD value.
 *
 * The bit field is as follows:
 *
 * bit31:25  Year from 1980 (0..127)
 *
 * bit24:21  Month (1..12)
 *
 * bit20:16  Day in month(1..31)
 *
 * bit15:11  Hour (0..23)
 *
 * bit10:5   Minute (0..59)
 *
 * bit4:0    Second/2 (0..29)
 *
 * \return Current time.
 */
DWORD get_fattime(void);
#endif

/* Unicode support functions */
#if _USE_LFN							/* Unicode - OEM code conversion */
WCHAR ff_convert (WCHAR chr, UINT dir);	/* OEM-Unicode bidirectional conversion */
WCHAR ff_wtoupper (WCHAR chr);			/* Unicode upper-case conversion */
#if _USE_LFN == 3						/* Memory functions */

/** \brief Allocate a memory block.
 *	If a NULL is returned, the file function fails with FR_NOT_ENOUGH_CORE.
 *
 * \param _msize	Number of bytes to allocate.
 *
 * \return Returns pointer to the allocated memory block.
 *
 */
void *ff_memalloc(UINT _msize);			/* Allocate memory block */

/** \brief Free a memory block.
 *
 * \param _mblock	Pointer to the memory block to free.
 *
 */
void ff_memfree(void *_mblock);			/* Free memory block */
#endif
#endif

/* Sync functions */
#if _FS_REENTRANT

/** \brief Create a Synchronization Object.
 *	This function is called in f_mount function to create a new.
 *	synchronization object, such as semaphore and mutex. When a FALSE is
 *	returned, the f_mount function fails with FR_INT_ERR.
 *
 * \param _vol	Corresponding logical drive being processed.
 * \param _sobj Pointer to return the created sync object.
 *
 * \return 1:Function succeeded, 0:Could not create due to any error.
 *
 */
int ff_cre_syncobj(BYTE _vol, _SYNC_t *_sobj);	/* Create a sync object */

/** \brief Request Grant to Access the Volume.
 *	This function is called on entering file functions to lock the volume.
 *	When a FALSE is returned, the file function fails with FR_TIMEOUT.
 *
 * \param _sobj	Sync object to wait.
 *
 * \return TRUE:Got a grant to access the volume, FALSE:Could not get a grant.
 *
 */
int ff_req_grant(_SYNC_t _sobj);				/* Lock sync object */

/** \brief Release Grant to Access the Volume.
 *	This function is called on leaving file functions to unlock the volume.
 *
 * \param _sobj	Sync object to be signaled.
 *
 */
void ff_rel_grant(_SYNC_t _sobj);				/* Unlock sync object */

/** \brief Delete a Synchronization Object.
 *	This function is called in f_mount function to delete a synchronization
 *	object that created with ff_cre_syncobj function. When a FALSE is
 *	returned, the f_mount function fails with FR_INT_ERR.
 *
 * \param _sobj		Sync object tied to the logical drive to be deleted .
 *
 * \return 1:Function succeeded, 0:Could not delete due to any error.
 *
 */
int ff_del_syncobj(_SYNC_t _sobj);				/* Delete a sync object */

#endif




/*--------------------------------------------------------------*/
/* Flags and offset address                                     */


/* File access control and file status flags (FIL.flag) */

#define	FA_READ				0x01
#define	FA_OPEN_EXISTING	0x00
#define FA__ERROR			0x80

#if !_FS_READONLY
#define	FA_WRITE			0x02
#define	FA_CREATE_NEW		0x04
#define	FA_CREATE_ALWAYS	0x08
#define	FA_OPEN_ALWAYS		0x10
#define FA__WRITTEN			0x20
#define FA__DIRTY			0x40
#endif


/* FAT sub type (FATFS.fs_type) */

#define FS_FAT12	1
#define FS_FAT16	2
#define FS_FAT32	3


/* File attribute bits for directory entry */

#define	AM_RDO	0x01	/* Read only */
#define	AM_HID	0x02	/* Hidden */
#define	AM_SYS	0x04	/* System */
#define	AM_VOL	0x08	/* Volume label */
#define AM_LFN	0x0F	/* LFN entry */
#define AM_DIR	0x10	/* Directory */
#define AM_ARC	0x20	/* Archive */
#define AM_MASK	0x3F	/* Mask of defined bits */


/* Fast seek feature */
#define CREATE_LINKMAP	0xFFFFFFFF



/*--------------------------------*/
/* Multi-byte word access macros  */

#if _WORD_ACCESS == 1	/* Enable word access to the FAT structure */
#define	LD_WORD(ptr)		(WORD)(*(WORD*)(BYTE*)(ptr))
#define	LD_DWORD(ptr)		(DWORD)(*(DWORD*)(BYTE*)(ptr))
#define	ST_WORD(ptr,val)	*(WORD*)(BYTE*)(ptr)=(WORD)(val)
#define	ST_DWORD(ptr,val)	*(DWORD*)(BYTE*)(ptr)=(DWORD)(val)
#else					/* Use byte-by-byte access to the FAT structure */
#define	LD_WORD(ptr)		(WORD)(((WORD)*((BYTE*)(ptr)+1)<<8)|(WORD)*(BYTE*)(ptr))
#define	LD_DWORD(ptr)		(DWORD)(((DWORD)*((BYTE*)(ptr)+3)<<24)|((DWORD)*((BYTE*)(ptr)+2)<<16)|((WORD)*((BYTE*)(ptr)+1)<<8)|*(BYTE*)(ptr))
#define	ST_WORD(ptr,val)	*(BYTE*)(ptr)=(BYTE)(val); *((BYTE*)(ptr)+1)=(BYTE)((WORD)(val)>>8)
#define	ST_DWORD(ptr,val)	*(BYTE*)(ptr)=(BYTE)(val); *((BYTE*)(ptr)+1)=(BYTE)((WORD)(val)>>8); *((BYTE*)(ptr)+2)=(BYTE)((DWORD)(val)>>16); *((BYTE*)(ptr)+3)=(BYTE)((DWORD)(val)>>24)
#endif

#ifdef __cplusplus
}
#endif

#endif /* _FATFS */
